home *** CD-ROM | disk | FTP | other *** search
/ Directorty Opus 5 - Magellan 2 / Opus 5 - Magellan 2.iso / Extras / opussdk / docs / progress.doc < prev    next >
Text File  |  1996-09-05  |  8KB  |  259 lines
  1. TABLE OF CONTENTS
  2.  
  3. dopus5.library/CheckProgressAbort
  4. dopus5.library/CloseProgressWindow
  5. dopus5.library/GetProgressWindow
  6. dopus5.library/HideProgressWindow
  7. dopus5.library/OpenProgressWindow
  8. dopus5.library/SetProgressWindow
  9. dopus5.library/ShowProgressWindow
  10. dopus5.library/CheckProgressAbort           dopus5.library/CheckProgressAbort
  11.  
  12.     NAME
  13.         CheckProgressAbort - check for abort in progress window
  14.  
  15.     SYNOPSIS
  16.         CheckProgressAbort(handle)
  17.                              A0
  18.  
  19.         BOOL CheckProgressAbort(APTR);
  20.  
  21.     FUNCTION
  22.         Allows you to check the state of the abort flag in the specified
  23.         progress window.
  24.  
  25.     INPUTS
  26.         handle - progress window handle
  27.  
  28.     RESULT
  29.         Returns TRUE if the Abort button has been clicked.
  30.  
  31.     SEE ALSO
  32.         OpenProgressWindow()
  33.  
  34. dopus5.library/CloseProgressWindow         dopus5.library/CloseProgressWindow
  35.  
  36.     NAME
  37.         CloseProgressWindow - close a progress window
  38.  
  39.     SYNOPSIS
  40.         CloseProgressWindow(handle)
  41.                               A0
  42.  
  43.         void CloseProgressWindow(APTR);
  44.  
  45.     FUNCTION
  46.         Closes the specified progress window.
  47.  
  48.     INPUTS
  49.         handle - progress window to close
  50.  
  51.     SEE ALSO
  52.         OpenProgressWindow()
  53.  
  54. dopus5.library/GetProgressWindow             dopus5.library/GetProgressWindow
  55.  
  56.     NAME
  57.         GetProgressWindow - get progress window information
  58.  
  59.     SYNOPSIS
  60.         GetProgressWindow(handle, tags)
  61.                             A0     A1
  62.  
  63.         void GetProgressWindow(APTR, struct TagItem *);
  64.  
  65.         void GetProgressWindowTags(APTR, Tag, ...);
  66.  
  67.     FUNCTION
  68.         Returns information about the progress window. Currently available
  69.         information is :
  70.  
  71.             PW_Window      - returns Window pointer
  72.  
  73.     INPUTS
  74.         handle - progress window handle
  75.         tags   - inquiry tags
  76.  
  77.     RESULT
  78.         The result of each tag query is stored in the ti_Data field of the
  79.         TagItem.
  80.  
  81.     SEE ALSO
  82.         OpenProgressWindow(), SetProgressWindow()
  83.  
  84. dopus5.library/HideProgressWindow           dopus5.library/HideProgressWindow
  85.  
  86.     NAME
  87.         HideProgressWindow - hide a progress window
  88.  
  89.     SYNOPSIS
  90.         HideProgressWindow(handle)
  91.                              A0
  92.  
  93.         void HideProgressWindow(APTR);
  94.  
  95.     FUNCTION
  96.         Removes the specified progress window from the display. The progress
  97.         window is still operative; it can still be updated and even closed
  98.         while it is hidden.
  99.  
  100.     INPUTS
  101.         handle - progress window handle
  102.  
  103.     SEE ALSO
  104.         OpenProgressWindow(), ShowProgressWindow()
  105.  
  106. dopus5.library/OpenProgressWindow           dopus5.library/OpenProgressWindow
  107.  
  108.     NAME
  109.         OpenProgressWindow - open a progress window display
  110.  
  111.     SYNOPSIS
  112.         OpenProgressWindow(tags)
  113.                             A0
  114.  
  115.         APTR OpenProgressWindow(struct TagItem *);
  116.  
  117.         APTR OpenProgressWindowTags(Tag, ...);
  118.  
  119.     FUNCTION
  120.         Opens a progress window that your application can use to display the
  121.         progression of some operation. The progress window can have a filename
  122.         display, file counter and progress guage.
  123.  
  124.     INPUTS
  125.         tags - control tags. Control tags are:
  126.  
  127.             PW_Screen    - screen to open on. The progress window will
  128.                            appear centered in the screen. Use of this tag
  129.                            overrides PW_Window.
  130.  
  131.             PW_Window    - window to open over. The progress window will
  132.                            appear centered over the supplied window.
  133.  
  134.             PW_Title     - title for the progress window
  135.  
  136.             PW_SigTask   - task to signal when the abort gadget is pressed.
  137.  
  138.             PW_SigBit    - bit to signal task with (signal bit, not mask)
  139.  
  140.             PW_FileName  - initial filename for display
  141.  
  142.             PW_FileSize  - initial file size
  143.     
  144.             PW_FileCount - initial file count
  145.  
  146.             PW_Flags     - control flags
  147.  
  148.         The control flags for the PW_Flags tag are :
  149.  
  150.             PWF_FILENAME  - specify if you want a filename display
  151.             PWF_FILESIZE  - specify if you want a file size display (1)
  152.             PWF_INFO      - specify if you want an information line
  153.             PWF_GRAPH     - specify if you want a bar graph display (1)
  154.             PWF_NOABORT   - specify if you don't want an Abort button (2)
  155.             PWF_INVISIBLE - if you want the progress window to open in 'hidden'
  156.                             mode (ie you need to call ShowProgressWindow() to
  157.                             make it visible)
  158.             PWF_ABORT     - specify if you do want an Abort button (2)
  159.  
  160.         1. Ordinarily, the file size is displayed as a "xxxxxx bytes" string in
  161.            the top-right of the progress window, and the bar graph is used to
  162.            represent "x out of y files". If, however, you specify both
  163.            PWF_FILESIZE and PWF_GRAPH, the meanings of these displays is
  164.            automatically swapped around. The current file progress (eg bytes
  165.            copied) is displayed in the bar graph, and the current operation
  166.            progress (eg files copied) is displayed in text in the top-right
  167.            corner.
  168.  
  169.         2. If you specify a signal task with the pw_SigTask flag, the
  170.            progress window will automatically get an Abort button. You can use
  171.            the PWF_NOABORT flag to stop this happening.
  172.  
  173.            If you do not specify the pw_SigTask flag, you can use the PWF_ABORT
  174.            flag to add an Abort button without signalling (you will need to
  175.            call CheckProgressAbort() to detect an abort).
  176.  
  177.     RESULT
  178.         Returns a handle to the newly created progress window, or NULL for
  179.         failure.
  180.  
  181.     SEE ALSO
  182.         SetProgressWindow(), CloseProgressWindow()
  183.  
  184. dopus5.library/SetProgressWindow             dopus5.library/SetProgressWindow
  185.  
  186.     NAME
  187.         SetProgressWindow - update progress window information
  188.  
  189.     SYNOPSIS
  190.         SetProgressWindow(handle, tags)
  191.                             A0     A1
  192.  
  193.         void SetProgressWindow(APTR, struct TagItem *);
  194.  
  195.         void SetProgressWindowTags(APTR, Tag, ...);
  196.  
  197.     FUNCTION
  198.         This is the routine you use to update the information displayed in
  199.         a progress window.
  200.  
  201.     INPUTS
  202.         handle - progress window handle
  203.         tags   - control tags. Valid tags are :
  204.  
  205.             PW_Title       - change the window title
  206.  
  207.             PW_FileName    - change the displayed filename
  208.  
  209.             PW_FileSize    - change the total size of the current file
  210.  
  211.             PW_FileDone    - change the "done" size of the current file
  212.                              (eg, if the file size was 12800 and you had
  213.                              copied half of it, the done size would be
  214.                              6400).
  215.  
  216.             PW_Info        - change the information field display
  217.  
  218.             PW_FileCount   - change the total number of files
  219.  
  220.             PW_FileNum     - change the number of files processed (eg,
  221.                              if the total file count was 84 and you had
  222.                              processed a quarter of them, the current
  223.                              file number would be 21).
  224.  
  225.     RESULT
  226.         The changes are displayed immediately. If the progress window is
  227.         currently hidden, the changes are still effective and will be
  228.         visible when the progress window is revealed.
  229.  
  230.     SEE ALSO
  231.         OpenProgressWindow()
  232.  
  233. dopus5.library/ShowProgressWindow           dopus5.library/ShowProgressWindow
  234.  
  235.     NAME
  236.         ShowProgressWindow - reveal a hidden progress window
  237.  
  238.     SYNOPSIS
  239.         ShowProgressWindow(handle, screen, window)
  240.                              A0      A1      A2
  241.  
  242.         void ShowProgressWindow(APTR, struct Screen *, struct Window *);
  243.  
  244.     FUNCTION
  245.         Reveals a progress window that was hidden with HideProgressWindow().
  246.  
  247.     INPUTS
  248.         handle - progress window handle
  249.         screen - new parent screen (if no window supplied)
  250.         window - new owner window (if no screen supplied)
  251.  
  252.     RESULT
  253.         The progress window is revealed. If possible, it will be displayed
  254.         at the same position on the screen as it was when it was hidden.
  255.  
  256.     SEE ALSO
  257.         OpenProgressWindow(), HideProgressWindow()
  258.  
  259.